<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>phpDocumentor » \Session</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">phpDocumentor</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu"></ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">86</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#destroy" title="destroy :: Destroy the entire session"><span class="description">Destroy the entire session</span><pre>destroy()</pre></a></li>
<li class="method public "><a href="#display" title="display :: Display the session with pre tags"><span class="description">Display the session with pre tags</span><pre>display()</pre></a></li>
<li class="method public "><a href="#get" title="get :: Grabs a value from the session"><span class="description">Grabs a value from the session</span><pre>get()</pre></a></li>
<li class="method public "><a href="#isStarted" title="isStarted :: "><span class="description">isStarted()
        </span><pre>isStarted()</pre></a></li>
<li class="method public "><a href="#set" title="set :: Sets a session value"><span class="description">Sets a session value</span><pre>set()</pre></a></li>
<li class="method public "><a href="#start" title="start :: Starts a session and only allows it to run once (Singleton-like)"><span class="description">Starts a session and only allows it to run once (Singleton-like)</span><pre>start()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header private">» Private</li>
<li class="property private "><a href="#%24_sessionStarted" title="$_sessionStarted :: "><span class="description">&lt;p&gt;A flag to tell whether we've run session_start()&lt;/p&gt;
</span><pre>$_sessionStarted</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5CSession" id="\Session"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/default.html">default</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/Session.html">Session</a>
</li>
</ul>
<div href="../classes/Session.html" class="element class"><div class="details">
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="destroy" id="destroy"></a><div class="element clickable method public destroy" data-toggle="collapse" data-target=".destroy .collapse">
<h2>Destroy the entire session</h2>
<pre>destroy() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="display" id="display"></a><div class="element clickable method public display" data-toggle="collapse" data-target=".display .collapse">
<h2>Display the session with pre tags</h2>
<pre>display() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="get" id="get"></a><div class="element clickable method public get" data-toggle="collapse" data-target=".get .collapse">
<h2>Grabs a value from the session</h2>
<pre>get(string $key, string $secondKey) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code>string</code><p>the name of the Session KEY</p></div>
<div class="subelement argument">
<h4>$secondKey</h4>
<code>string</code><p>the name of a Second Session KEY (Within a Session Multi-Dimensional Array)</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>Either the value or false</div>
</div></div>
</div>
<a name="isStarted" id="isStarted"></a><div class="element clickable method public isStarted" data-toggle="collapse" data-target=".isStarted .collapse">
<h2>isStarted()
        </h2>
<pre>isStarted() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="set" id="set"></a><div class="element clickable method public set" data-toggle="collapse" data-target=".set .collapse">
<h2>Sets a session value</h2>
<pre>set(string $key, string $value) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$key</h4>
<code>string</code><p>The name</p></div>
<div class="subelement argument">
<h4>$value</h4>
<code>string</code><p>The value</p></div>
</div></div>
</div>
<a name="start" id="start"></a><div class="element clickable method public start" data-toggle="collapse" data-target=".start .collapse">
<h2>Starts a session and only allows it to run once (Singleton-like)</h2>
<pre>start() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24_sessionStarted" id="$_sessionStarted"> </a><div class="element clickable property private $_sessionStarted" data-toggle="collapse" data-target=".$_sessionStarted .collapse">
<h2>&lt;p&gt;A flag to tell whether we've run session_start()&lt;/p&gt;
</h2>
<pre>$_sessionStarted : boolean</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
</div></div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a3</a> and<br>
            generated on </footer></div>
</div>
</body>
</html>
